jas.jds.module
Class BasicLocalDIM

java.lang.Object
  |
  +--jas.jds.module.BasicLocalDIM

All Implemented Interfaces:

AbstractDIM, LocalDIM, LocalDIM2, java.io.Serializable

Direct Known Subclasses:

MultiFileLocalDIM

public abstract class BasicLocalDIM

extends java.lang.Object

implements LocalDIM2

An abstract implementation of LocalDIM2 suitable for DIM's which simply want to open a single file of a particular type

See Also:

MultiFileLocalDIM, Serialized Form

Constructor Summary

BasicLocalDIM(javax.swing.filechooser.FileFilter f)
Create a BasicLocalDIM.

BasicLocalDIM(java.lang.String description, java.lang.String filetype)
Create a BasicLocalDIM.

Method Summary

javax.swing.filechooser.FileFilter	getFileFilter()
java.lang.String	getHelpTopic() Override to provide your own help topic
JASWizardPage	getSetupPage() Return a setup page for the new job wizard to use when creating a job.
void	setLocalJobBuilder(LocalJobBuilder ljb) Copy over the given object to a member field for use later.
java.lang.String	toString() Override to provide your own description of the filetype in the LocalJobWizard page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jas.jds.module.AbstractDIM

openDataSet

Constructor Detail

BasicLocalDIM

public BasicLocalDIM(javax.swing.filechooser.FileFilter f)

Create a BasicLocalDIM. Specify a FileFilter that describes the type of files you want to open.

BasicLocalDIM

public BasicLocalDIM(java.lang.String description,
                     java.lang.String filetype)

Create a BasicLocalDIM. Specify a description of the files, and a filetype (e.g. .hbook)

Parameters:

description - Description of the files

filetype - The file type

Method Detail

getSetupPage

public JASWizardPage getSetupPage()

Description copied from interface: LocalDIM

Return a setup page for the new job wizard to use when creating a job. See the documentation on defining pages.

Specified by:

getSetupPage in interface LocalDIM

setLocalJobBuilder

public void setLocalJobBuilder(LocalJobBuilder ljb)

Description copied from interface: LocalDIM

Copy over the given object to a member field for use later. When the user selects a DIM, the wizard invokes this method, thereby providing the DIM with access to the application's local job builder. That local job builder already knows which DIM to use and knows the job name, and can be used to create a new job when all setup (on the setup wizard page returned by getSetupPage()) is complete.

Specified by:

setLocalJobBuilder in interface LocalDIM

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Specified by:

getFileFilter in interface LocalDIM2

toString

public java.lang.String toString()

Override to provide your own description of the filetype in the LocalJobWizard page. By default uses the description from the file filter.

Overrides:

toString in class java.lang.Object

getHelpTopic

public java.lang.String getHelpTopic()

Override to provide your own help topic